MODSIM-DSS Release Notes MODSIM-DSS is a generalized river basin Decision Support System and network flow model developed at Colorado State University designed specifically to meet the growing demands and pressures on river basin managers today. -------------------------------------------------------------------------------- Changelog Guide: -------------------------------------------------------------------------------- [!] Important [+] New [-] Fixed [*] Changed -------------------------------------------------------------------------------- Version 8.6 (Prerelease 8/1/2021): -------------------------------------------------------------------------------- System Requirements: * Microsoft .NET 3.5 * (optional) Microsoft Office for mdb output format Changelog: [!] Implements an option to output the simulation results into an SQLite database. While the mdb output is still operational the dependency on MS-Access drivers and incompatibitilitie with newer version of Office, users are encouraged to use SQLite database as default output format. The output format can be changed in the user interface. Daily time series run [!] Time series can be stored in a SQLite database. This implementation support unique database files for each XY file or a central database that can be shared among multiple XY files. This implementation supports time series scenarios stored in the same database to be loaded into the same netowrk. The default database has the name of the XY file, but an SQLite file could be used to serve different XY files that share the same nodes and links guid. [!] Measured Flows can be defined a network links. Measured flows are used to compare simlated flows with a measured (observed) time series. These time series are stored with the rest of the time series and are available in the output. The logic accepts negative numbers for missing data, which are skipped in the comparison statistics. A time series comparison dashboard is implemented in the output form to compare simulated flow with measured flows. [!] General Functionality [!] Storage Accounts with Dead Storage: This feature improves the accounting of storage accounts when the reservoir has dead storage, excluding water trapped in the dead storage from the accounts. Reservoir accounts setup includes the dead storage, making the available water for accounts only the available storage (above the dead storage). When evaporation brings the level of the reservoir below the dead storage, there is accrual through the accrual links (based on seniority) but storage left only is accounted when volumes are above the dead storage. The storage left only shows water available to be released. This implies that the most senior will be charged with replenishing the dead storage - if only this right is in priority. [!] Default Maximum with Decimal Accuracy: (Interface) The default capacity uses the user defined accuracy factor to set the defaults in the network. The default maximum was implemented to be synchronized with the user selected decimal accuracy. This avoids getting errors when the internal integer numbers with the accuracy factors were bigger than the default capacity. This change includes using the accuracy factor in the reservoirs EAC curve for the capacity. EAC capacity from legacy networks imported into this version will be multiplied by the ScaleFactor to work with version 8.6. [!] Fix changing units for time series in the interface: Changing units in the GUI forms for existing time series were not updated unless a value in the time series was changed, keeping to the original value. The units can be changed now in the time series without having to edit values. -------------------------------------------------------------------------------- Version 8.5.1 (Prerelease 11/23/2017 - Released 08/05/2018): -------------------------------------------------------------------------------- System Requirements: * Microsoft .NET 3.5 * Microsoft Office Changelog: [!] Fixed convergence of FlowThru demands, in cases that the return flow did not matched the final iteration water delivered to the demand node. [!] Fixed watchlink convergence, which was been overwritten by the exchange credit link convergence. This would have affected networks with "circular references" or non-unique solutions. [+] Added a smoothing converge algorithm to help watchlink demands to converge when the solution oscillates between two solutions. The algorithm sets the demand to half of oscillation difference [*] Improved output graphics defaults using lines for volume display and average rates at the mid-date of the time step. Improved context menus display options and added highlighting lines functionality from the elements list. [+] Added handling of the user additional variables in the model output processing. -------------------------------------------------------------------------------- Version 8.5.0 (Released 2/22/2016): -------------------------------------------------------------------------------- System Requirements: * Microsoft .NET 3.5 * Microsoft Office Changelog: [-] Issue #35. Datetime exception if data start date is in January or February and the following year is a leap year. [-] Issue #36. Channel loss not calculated if loss coefficient >= 0.5. And computed channel loss incorrect. [-] Exceedance values not shown in status bar of exceedance plot. [-] Metric Units message box displayed on opening Network Settings. -------------------------------------------------------------------------------- Version 8.4.5 (Released 2/9/2016): -------------------------------------------------------------------------------- System Requirements: * Microsoft .NET 3.5 * Microsoft Office Changelog: [+] Ability to install MODSIM with or without Administrator privileges. [+] Error message if duplicate node or link names are found while opening model. [*] Removed Import/Export of Version 7 Timeseries. [*] Improved convergence check method. [*] GUI Forms do not close on OK click if model updates fail. [*] OK button disabled on Script References form until a dll is selected. [-] Unable to add references to custom code editor. [-] Unhandled exception if custom code file does not exist and user clicks on File->Compile. [-] Removed duplicate system dll's from Script References form. [-] Selection of duplicate dll's in Script References form no longer possible. [-] Do not add duplicate references to custom code editor. [-] Default convergence buttons in Network Settings resets current model convergence settings not default model convergence settings. [-] Disable File->Import and File->Export options if menu items are disabled. They previously became visible and were enabled after viewing Recent Files, but should have remained hidden. [-] Index out of bounds loading Version 7 file with power efficiency table. [-] Edit->Link Search->By List always showed link type as Standard. -------------------------------------------------------------------------------- Version 8.4.4 (Released 1/15/2016): -------------------------------------------------------------------------------- System Requirements: * Microsoft .NET 3.5 * Microsoft Office Changelog: [!] Could affect users custom code. Array length variables: demListLen, childListLen, parentListLen, ownerListLen, realNodesListLen, importNodesLen, inflowNodesLen, realLinkListLen, variableCapLinkListLen, accrualLinkListLen, lastFillLinkListLen, nListLen, lListLen, outputNodeListLen, outputLinkListLen, and ownerChanlossListLen were deleted. Please use the array's length property in custom code, for example: demList.Length. [+] Link/node name added to MODSIM Output Display DATA tab table. [+] Ability to reset model convergence criteria to defaults. [-] Right-click Paste Column for groundwater lags did not clear previous lags. [-] Allow access to ModsimModel Utils class from custom code. [-] MODSIM Output Display default size zero on first install of MODSIM. [-] Application crash if new model created and run. [-] Natural flow allocation incorrect with non-default node priorities. [-] Issue #29. Output mdb data in wrong column with selective output. [-] Outflow from NonStorage incorrect with multiple flow thru inflows if inflow comes from a flow thru with a bypass credit link. [-] Issue #33. Unable to convert string to proper datetime with non-default Microsoft Windows Short Date Region Format setting. [*] Milisecond time step removed. [*] Reservoir target link cost set to match documentation, Fig. 47. [*] Right-click Paste and Paste With Data options disabled until a valid Paste operation is available. -------------------------------------------------------------------------------- Version 8.4.3 (Released 6/30/2015): -------------------------------------------------------------------------------- System Requirements: * Microsoft .NET 3.5 * Microsoft Office Changelog: [*] Allow importing background images in all supported formats. [-] Issue #27. Cannnot save new networks. -------------------------------------------------------------------------------- Version 8.4.2 (Released 5/30/2015): -------------------------------------------------------------------------------- System Requirements: * Microsoft .NET 3.5 * Microsoft Office Changelog: [+] Evaporation Convergence added to Network Settings. Used in convergence tests of ending storage with reservoir evaporation calculations. [*] Put custom code editor gui components into split containers that can be resized however the user would like. [*] Recent files list moved to File->Open Recent. [*] Graph follows MODSIM time step for 15 minute, hourly, daily, weekly, and monthly time steps. [*] Keep Node Palette as top pallete when using background images. [*] Multilink arrowhead size decreased to same size as single link arrowhead size. [*] Keyboard shortcut Ctrl->Shift->S now operates Save As instead of Save All. [*] Model output datetime, both mdb and csv, and xy file now use the format, 'mm/dd/yyyy hh:mm:ss'. This is now consistent across MODSIM. [*] Model mdb output tables now strongly typed. The database column datatype forces the data to that type. If the column is Integer datatype then the data will be Integers. [-] Issue #19. Plot short date for model timesteps greater than hourly. [-] Message list not cleared when network closed. [-] Issue #13. Cost on artificial target storage link for storage right reservoir incorrect. [-] Issue #14. Link defaults to Standard if water rights date defined for Last Fill link. [-] Issue #15. Water rights date not saved for Last Fill links. [-] Issue #16. Link defaults to Storage Right after clicking OK on Water Right Control for Last Fill links. [-] Issue #17. Custom code that used link.m.maxConstant did not function properly. [-] Issue #18. Crash while graphing if certain model outputs disabled, like ending elevation. [-] Issue #20. Unhandled exception if Mid-Date not in MODSIM Output Display data, line graph. [-] Issue #22. Flow thru node with storage ownership in a zero system number reservoir receives no water through its storage ownership link. [-] Issue #23. Location of flow thru nodes returns incorrectly affects allocation. [-] Issue #24. The NonStorage nodes Flow-Thru Inflow does not include stored water delivery. [-] Issue #25. Index out of range exception with back-routing extension enabled. [-] Issue #26. NonStorage timeseries, varies by year change not saved. [-] Link channel type data not cleared when switched. [-] Scale background images with monitor DPI settings. [-] MODSIM->Graphing Mode, MODSIM->Scenarios Analysis, and MODSIM->Animated Output became disabled if one was selected and all networks were closed. [-] Save As dialog opened to last opened network location not current network location. [-] Writing output done at MODSIM->Output Control->Number of Time Steps in Memory + 2, now follows Number of Time Steps in Memory. [-] Empty row inserted into reservoir targets data on start date change. [-] Model name in xy file not changed on Save As. -------------------------------------------------------------------------------- Version 8.4.1 (Released 3/2/2015): -------------------------------------------------------------------------------- System Requirements: * Microsoft .NET 3.5 * Microsoft Office Changelog: [!] Do not write "priority" values to Demand nodes in the xy file. It has no meaning for Demand nodes. The variable for Demand nodes is "demr". [*] Close all Modsim forms when network veiw is closed. [*] Increase/decrease background image size changed to zoom level. [-] Unhandled exception on right-click References area of custom code editor. [-] Flow duration curve not available after Clear Plot clicked. [-] Unhandled exception on copy/paste nodes/links. Improved functionality. [-] Import timeseries from Excel, first date incorrect. [-] Follow link seasonal capacity for daily timesteps. [-] Nodes incorrectly located in GUI if node size not default 100. [-] Edit->Resize Nodes and Edit->Resize Links at 25% doesn't save. -------------------------------------------------------------------------------- Version 8.4.0 (Released 1/12/2015): -------------------------------------------------------------------------------- System Requirements: * Microsoft .NET 3.5 * Microsoft Office Changelog: [!] Model runtime decreased by at least 50%. [!] Due to a bug-fix, node label locations from previous version model files have not been maintained. The label will be centered beneath the node. [!] If you have Microsoft Office (32-bit) installed you must use the 32-bit version of MODSIM-DSS. Likewise if you have Microsoft Office (64-bit) installed you must use the 64-bit version of MODSIM-DSS. Go to File->Help in Microsoft Office to determine whether you have the 32-bit or 64-bit version installed. [!] Ability to run modsim.exe from the Microsoft Windows Command Prompt by specifying "modsim.exe -nogui model.xy". Allows batch mode running of models. [+] Single year toggle button in timeseries Plot tab if varies by year is not checked. [+] Water rights import/export using csv format. [+] Show initial storage and target on graph. [+] A mid-point for new links is automatically created. [+] Model run progress bar added to status strip. [*] Removed water rights import/export in version 7 format. [*] Removed partial ability to save to previous versions, and Save would try to save the model at the same version. Save now saves the model in the current version. If you need to keep a model at a specific version use that specific version of MODSIM-DSS. [*] Show forms on monitor where parent form is. [*] Make node/link/multilink/script editor forms modeless (i.e., multiple forms can be open at once). [*] Do not load a model in the GUI if there are model file read errors. [*] New installer based on WiX Toolset. [*] Allow 32bit version of Modsim to use up to 4GB of memory. [*] Improved handling of loading version 7 files. [*] Models no longer automatically restart on infeasible solution, this can be configured in the Network Settings. [*] Recent files list - properly show the list, show the last 6 models, and disable unavailable models. [*] Delay in displaying MODSIM Messages window removed. [*] Decrease sum of lags equal 1 error check to two significant digits. [*] Flow thru demand with bypass credit link defined, remove only amount demanded greater than bypass credit link flow. [*] GUI icons, menus's, and contextmenu's with new .net components. [*] Remove negative value warning message on model read for node position and node priority. [*] Old .net statusbar replaced with new .net statusstrip. [*] Enable MODSIM->Cost Analysis tool for run type Conditional Rules for links. [-] Paste table into State Boundary Factors table incorrect. [-] Copy/paste in Power Plant Elevation table for constant elevation type. [-] View->Properties not enabled when no views are open and then a network is opened or created. [-] Correctly display forms at > 96 DPI monitor settings. [-] Groundwater convergence and flow thru convergence in Network Settings improperly saved as integers. [-] Always show model file units in GUI. [-] Unable to create link from multilink form. [-] Constrain storage group contracts to the group seasonal capacity for zero system number reservoirs. [-] Water rights import/export using Microsoft Access mdb file. [-] No 64bit mdb output. [-] Custom code editor not correctly getting all necessary dll's. [-] Unable to remove storage channel loss link or storage limit link once set. [-] No accrual to zero system number reservoirs in a network with non-zero system number reservoirs. [-] Previously hidden label remains visible on reopening model. [-] In certain models node labels would move every time the network was saved. [-] Various issues with proper generation of the model output mdb file. [-] Varies by year not checked, correctly calculate flow per timestep (i.e., based on the days per month). [-] Follow accrual link max rate for not varies by year data. [-] Natural flow link max rate doubles if OK pressed on Water Rights Control form. [-] Rent limits not scaled on model settings precision change, and not properly shown or saved in link form. [-] Power plant efficiency flows not scaled on model settings precision change. [-] Graph form height not properly saved. [-] Storage contract delivery incorrect in certain models after changing model precision from zero to greater than zero. [-] Model GUI view upper left location not properly set. Caused portions of a model to not be visible and/or the horizontal scroll bar to be visible when it is unnecessary. [-] MODSIM->Water Right Control->Generate Cost incorrectly filtered rights with variable capacity and no seasonal capacity. The cost for these links was not being set. [-] MODSIM->Cost Analysis not saving changes to storage contract links relative order of use. -------------------------------------------------------------------------------- Version 8.3.2 (Released 3/21/2013): -------------------------------------------------------------------------------- System Requirements: * Microsoft .NET 4.0 * Microsoft Office Changelog: [+] 64-bit version. Allows simulation of larger systems (>4GB when loaded in memory). [+] Default max link capacity in Network Settings. [+] Support for Microsoft Access 2007 and 2010. [+] Export results to Excel. [+] Copy data from plots. [+] Sub-daily timesteps and user-defined timesteps can now be used. [*] A wider variety of units can be selected for input data. [*] Convert and fill units now user selectable (can be time consuming at the beginning of the MODSIM-DSS run for large networks). [*] Unique names for all artificial nodes and links. [*] Improved accuracy handling. Can now specify the desired number of digits after the decimal point! [*] Artificial links and nodes have names by which to identify them. -------------------------------------------------------------------------------- Version 8.1 (Released 10/18/2011): -------------------------------------------------------------------------------- System Requirements: * Microsoft .NET 1.1 * Microsoft Office Changelog: [+] Additional functionality (i.e., Storage Right Reservoir). [+] Custom code interface. [+] Network overview window to navigate large networks. [+] Ability to incorporate MODSIM-DSS with ArcGIS interface. [+] Powerful graphing tool. [+] Water rights management tool. [*] Easier to use interface and data entry forms.